<?php
/**
 * Ruth Library
 * $Id: Filter.php 2 2008-01-17 02:59:56Z baron314159@yahoo.com $
 *
 * LICENSE
 *
 * Copyright (c) 2007, Chris Utz
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the Impact Lab nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY CHRIS UTZ ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL CHRIS UTZ BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * @category   Ruth
 * @package    Ruth_Filter
 * @author     Chris Utz <chris@chrisutz.com>
 * @copyright  2007 Chris Utz <chris@chrisutz.com>
 * @license    http://www.opensource.org/licenses/bsd-license.php    New BSD License
 * @version    $Revision: 2 $
 */

/**
 * @see Ruth_Filter_Exception
 */
require_once 'Ruth/Validate/Exception.php';

/**
 * @see Ruth_ClassFactory
 */
require_once 'Ruth/ClassFactory.php';

/**
 * @see Ruth_Exception
 */
require_once 'Ruth/Exception.php';

/**
 * Provides facade for instantiating Ruth_Filter_Abstract subclasses.
 *
 * @category   Ruth
 * @package    Ruth_Filter
 * @author     Chris Utz <chris@chrisutz.com>
 * @copyright  2007 Chris Utz <chris@chrisutz.com>
 * @license    http://www.opensource.org/licenses/bsd-license.php    New BSD License
 * @version    $Revision: 2 $
 */
class Ruth_Filter
{
    /**
     * Class factory used to instantiate Ruth_Filter_* classes.
     *
     * @var Ruth_ClassFactory
     */
    public static $classFactory;

    /**
     * Instantiates a descendent of Ruth_Filter_Abstract
     *
     * @param string $baseClassName
     * @param array $args
     * @throws Ruth_Filter_Exception
     */
    public static function instantiate($baseClassName, array $options=array())
    {
        try {
            $args = array($options);
            $inst = self::$classFactory->instantiate($baseClassName, $args);
        } catch (Ruth_Exception $e) {
            throw new Ruth_Filter_Exception("[rethrown]: ".$e->getMessage());
        }

        if (!($inst instanceof Ruth_Filter_Abstract)) {
            throw new Ruth_Filter_Exception("Can only instantiate descendents of Ruth_Filter_Abstract");
        }

        return $inst;
    }

    /**
     * Instantiates a descendent of Ruth_Filter_Abstract and invokes its
     * filter method on $value.
     *
     * @param string $value The value to filter.
     * @param string $baseClassName The base name of the class to instantiate
     * @param array $options Options to pass to the constructor of the filter.
     * @return string|array The filtered value.
     */
    public static function filter($value, $baseClassName, array $options=array())
    {
        $filter = self::instantiate($baseClassName, $options);

        if (is_array($value)) {
            self::_filterRecursive($filter, $value);
        } else {
            $value = $filter->filter((string) $value);
        }

        return $value;
    }

    /**
     * 
     */
    protected function _filterRecursive(Ruth_Filter_Abstract $filter, array &$values)
    {
        foreach ($values as &$value) {
            if (is_array($value)) {
                self::_filterRecursive($filter, $value);
            } else {
                $value = $filter->filter((string) $value);
            }
        }
    }
}

Ruth_Filter::$classFactory = new Ruth_ClassFactory();
Ruth_Filter::$classFactory->appendNamespace('Ruth_Filter');
 
// vim: sw=4:ts=4:sts=4:et
